<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
	"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
	<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />

	<title>RDoc Documentation</title>

	<link type="text/css" media="screen" href="rdoc.css" rel="stylesheet" />

	<script src="js/jquery.js" type="text/javascript" charset="utf-8"></script>
	<script src="js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
	<script src="js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
	<script src="js/darkfish.js" type="text/javascript" charset="utf-8"></script>

</head>
<body class="indexpage">

	
	<h1>RDoc Documentation</h1>

	
	<p>This is the API documentation for 'RDoc Documentation'.</p>
	

	
	
	<h2>Files</h2>
	<ul>
		
			<li class="file"><a href="CHANGELOG.html">CHANGELOG</a></li>
		
			<li class="file"><a href="TODO.html">TODO</a></li>
		
	</ul>
	

	<h2 id="classes">Classes/Modules</h2>
	<ul>
		
		<li class="module"><a href="Retreval.html">Retreval</a></li>
		
		<li class="class"><a href="Retreval/Document.html">Retreval::Document</a></li>
		
		<li class="class"><a href="Retreval/GoldStandard.html">Retreval::GoldStandard</a></li>
		
		<li class="class"><a href="Retreval/Judgement.html">Retreval::Judgement</a></li>
		
		<li class="class"><a href="Retreval/Options.html">Retreval::Options</a></li>
		
		<li class="class"><a href="Retreval/Query.html">Retreval::Query</a></li>
		
		<li class="class"><a href="Retreval/QueryResult.html">Retreval::QueryResult</a></li>
		
		<li class="class"><a href="Retreval/QueryResultSet.html">Retreval::QueryResultSet</a></li>
		
		<li class="class"><a href="Retreval/RankedQueryResult.html">Retreval::RankedQueryResult</a></li>
		
		<li class="class"><a href="Retreval/ResultDocument.html">Retreval::ResultDocument</a></li>
		
		<li class="class"><a href="Retreval/Runner.html">Retreval::Runner</a></li>
		
		<li class="class"><a href="Retreval/UnrankedQueryResult.html">Retreval::UnrankedQueryResult</a></li>
		
		<li class="class"><a href="Retreval/User.html">Retreval::User</a></li>
		
		<li class="class"><a href="TestGoldStandard.html">TestGoldStandard</a></li>
		
		<li class="class"><a href="TestQueryResult.html">TestQueryResult</a></li>
		
	</ul>

	<h2 id="methods">Methods</h2>
	<ul>
		
			<li><a href="Retreval/GoldStandard.html#method-c-new">::new &mdash; Retreval::GoldStandard</a></li>
		
			<li><a href="Retreval/QueryResult.html#method-c-new">::new &mdash; Retreval::QueryResult</a></li>
		
			<li><a href="Retreval/QueryResultSet.html#method-c-new">::new &mdash; Retreval::QueryResultSet</a></li>
		
			<li><a href="Retreval/RankedQueryResult.html#method-c-new">::new &mdash; Retreval::RankedQueryResult</a></li>
		
			<li><a href="Retreval/Query.html#method-c-new">::new &mdash; Retreval::Query</a></li>
		
			<li><a href="Retreval/Options.html#method-c-new">::new &mdash; Retreval::Options</a></li>
		
			<li><a href="Retreval/Document.html#method-c-new">::new &mdash; Retreval::Document</a></li>
		
			<li><a href="Retreval/Judgement.html#method-c-new">::new &mdash; Retreval::Judgement</a></li>
		
			<li><a href="Retreval/Runner.html#method-c-new">::new &mdash; Retreval::Runner</a></li>
		
			<li><a href="Retreval/ResultDocument.html#method-c-new">::new &mdash; Retreval::ResultDocument</a></li>
		
			<li><a href="Retreval/UnrankedQueryResult.html#method-c-new">::new &mdash; Retreval::UnrankedQueryResult</a></li>
		
			<li><a href="Retreval/User.html#method-c-new">::new &mdash; Retreval::User</a></li>
		
			<li><a href="Retreval/GoldStandard.html#method-i-%3C%3C">#<< &mdash; Retreval::GoldStandard</a></li>
		
			<li><a href="Retreval/QueryResult.html#method-i-%3C%3C">#<< &mdash; Retreval::QueryResult</a></li>
		
			<li><a href="Retreval/Query.html#method-i-%3D%3D">#== &mdash; Retreval::Query</a></li>
		
			<li><a href="Retreval/Judgement.html#method-i-%3D%3D">#== &mdash; Retreval::Judgement</a></li>
		
			<li><a href="Retreval/User.html#method-i-%3D%3D">#== &mdash; Retreval::User</a></li>
		
			<li><a href="Retreval/Document.html#method-i-%3D%3D">#== &mdash; Retreval::Document</a></li>
		
			<li><a href="Retreval/QueryResult.html#method-i-add_document">#add_document &mdash; Retreval::QueryResult</a></li>
		
			<li><a href="Retreval/GoldStandard.html#method-i-add_judgement">#add_judgement &mdash; Retreval::GoldStandard</a></li>
		
			<li><a href="Retreval/User.html#method-i-add_judgement">#add_judgement &mdash; Retreval::User</a></li>
		
			<li><a href="TestQueryResult.html#method-i-add_ranked_query_result">#add_ranked_query_result &mdash; TestQueryResult</a></li>
		
			<li><a href="Retreval/QueryResultSet.html#method-i-add_result">#add_result &mdash; Retreval::QueryResultSet</a></li>
		
			<li><a href="TestGoldStandard.html#method-i-add_test_judgement">#add_test_judgement &mdash; TestGoldStandard</a></li>
		
			<li><a href="TestQueryResult.html#method-i-add_test_judgements">#add_test_judgements &mdash; TestQueryResult</a></li>
		
			<li><a href="TestQueryResult.html#method-i-add_unranked_query_result">#add_unranked_query_result &mdash; TestQueryResult</a></li>
		
			<li><a href="Retreval/RankedQueryResult.html#method-i-average_precision">#average_precision &mdash; Retreval::RankedQueryResult</a></li>
		
			<li><a href="Retreval/Runner.html#method-i-begin_calculations">#begin_calculations &mdash; Retreval::Runner</a></li>
		
			<li><a href="Retreval/QueryResult.html#method-i-calculate">#calculate &mdash; Retreval::QueryResult</a></li>
		
			<li><a href="Retreval/QueryResult.html#method-i-cleanup">#cleanup &mdash; Retreval::QueryResult</a></li>
		
			<li><a href="Retreval/GoldStandard.html#method-i-contains_document%3F">#contains_document? &mdash; Retreval::GoldStandard</a></li>
		
			<li><a href="Retreval/GoldStandard.html#method-i-contains_judgement%3F">#contains_judgement? &mdash; Retreval::GoldStandard</a></li>
		
			<li><a href="Retreval/GoldStandard.html#method-i-contains_query%3F">#contains_query? &mdash; Retreval::GoldStandard</a></li>
		
			<li><a href="Retreval/GoldStandard.html#method-i-contains_user%3F">#contains_user? &mdash; Retreval::GoldStandard</a></li>
		
			<li><a href="Retreval/RankedQueryResult.html#method-i-eleven_point_precision">#eleven_point_precision &mdash; Retreval::RankedQueryResult</a></li>
		
			<li><a href="Retreval/QueryResult.html#method-i-f_measure">#f_measure &mdash; Retreval::QueryResult</a></li>
		
			<li><a href="Retreval/GoldStandard.html#method-i-kappa">#kappa &mdash; Retreval::GoldStandard</a></li>
		
			<li><a href="Retreval/GoldStandard.html#method-i-load_from_plaintext_file">#load_from_plaintext_file &mdash; Retreval::GoldStandard</a></li>
		
			<li><a href="Retreval/GoldStandard.html#method-i-load_from_yaml_file">#load_from_yaml_file &mdash; Retreval::GoldStandard</a></li>
		
			<li><a href="Retreval/QueryResultSet.html#method-i-load_from_yaml_file">#load_from_yaml_file &mdash; Retreval::QueryResultSet</a></li>
		
			<li><a href="Retreval/QueryResult.html#method-i-load_from_yaml_file">#load_from_yaml_file &mdash; Retreval::QueryResult</a></li>
		
			<li><a href="Retreval/Runner.html#method-i-load_gold_standard">#load_gold_standard &mdash; Retreval::Runner</a></li>
		
			<li><a href="Retreval/Runner.html#method-i-load_query_result_set">#load_query_result_set &mdash; Retreval::Runner</a></li>
		
			<li><a href="Retreval/QueryResultSet.html#method-i-mean_average_precision">#mean_average_precision &mdash; Retreval::QueryResultSet</a></li>
		
			<li><a href="Retreval/GoldStandard.html#method-i-pairwise_kappa">#pairwise_kappa &mdash; Retreval::GoldStandard</a></li>
		
			<li><a href="Retreval/Options.html#method-i-parse">#parse &mdash; Retreval::Options</a></li>
		
			<li><a href="Retreval/QueryResult.html#method-i-print_contingency_table">#print_contingency_table &mdash; Retreval::QueryResult</a></li>
		
			<li><a href="Retreval/RankedQueryResult.html#method-i-print_eleven_point_precision_table">#print_eleven_point_precision_table &mdash; Retreval::RankedQueryResult</a></li>
		
			<li><a href="Retreval/RankedQueryResult.html#method-i-print_ranked_table">#print_ranked_table &mdash; Retreval::RankedQueryResult</a></li>
		
			<li><a href="Retreval/GoldStandard.html#method-i-relevant%3F">#relevant? &mdash; Retreval::GoldStandard</a></li>
		
			<li><a href="Retreval/Runner.html#method-i-run">#run &mdash; Retreval::Runner</a></li>
		
			<li><a href="Retreval/RankedQueryResult.html#method-i-statistics">#statistics &mdash; Retreval::RankedQueryResult</a></li>
		
			<li><a href="Retreval/UnrankedQueryResult.html#method-i-statistics">#statistics &mdash; Retreval::UnrankedQueryResult</a></li>
		
			<li><a href="TestGoldStandard.html#method-i-test_document">#test_document &mdash; TestGoldStandard</a></li>
		
			<li><a href="TestQueryResult.html#method-i-test_eleven_point_precision">#test_eleven_point_precision &mdash; TestQueryResult</a></li>
		
			<li><a href="TestGoldStandard.html#method-i-test_judgement">#test_judgement &mdash; TestGoldStandard</a></li>
		
			<li><a href="TestGoldStandard.html#method-i-test_kappa_ir_book">#test_kappa_ir_book &mdash; TestGoldStandard</a></li>
		
			<li><a href="TestGoldStandard.html#method-i-test_kappa_wikipedia">#test_kappa_wikipedia &mdash; TestGoldStandard</a></li>
		
			<li><a href="TestGoldStandard.html#method-i-test_query">#test_query &mdash; TestGoldStandard</a></li>
		
			<li><a href="TestQueryResult.html#method-i-test_ranked_precision">#test_ranked_precision &mdash; TestQueryResult</a></li>
		
			<li><a href="TestQueryResult.html#method-i-test_ranked_recall">#test_ranked_recall &mdash; TestQueryResult</a></li>
		
			<li><a href="TestGoldStandard.html#method-i-test_relevant">#test_relevant &mdash; TestGoldStandard</a></li>
		
			<li><a href="TestQueryResult.html#method-i-test_unranked_precision">#test_unranked_precision &mdash; TestQueryResult</a></li>
		
			<li><a href="TestQueryResult.html#method-i-test_unranked_recall">#test_unranked_recall &mdash; TestQueryResult</a></li>
		
			<li><a href="TestGoldStandard.html#method-i-test_user">#test_user &mdash; TestGoldStandard</a></li>
		
			<li><a href="Retreval/Runner.html#method-i-write_to_yaml_file">#write_to_yaml_file &mdash; Retreval::Runner</a></li>
		
	</ul>

	<div id="validator-badges">
		<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
		<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
			Rdoc Generator</a> 1.1.6</small>.</p>
	</div>
</body>
</html>
